home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / lisp / utils / finder.el.z / finder.el
Encoding:
Text File  |  1998-05-21  |  13.5 KB  |  401 lines
  1. ;;; finder.el --- topic & keyword-based code finder
  2.  
  3. ;; Copyright (C) 1992 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
  6. ;; Created: 16 Jun 1992
  7. ;; Version: 1.0
  8. ;; Keywords: help
  9. ;; X-Modified-by: Bob Weiner <weiner@mot.com>, 4/18/95, to include Lisp
  10. ;;    library directory names in finder-program-info, for fast display of
  11. ;;    Lisp libraries and associated commentaries.  Added {v}, finder-view,
  12. ;;    and {e}, finder-edit commands for displaying libraries.
  13. ;;    
  14. ;;    Added user variable, 'finder-abbreviate-directory-list', used to
  15. ;;    abbreviate directories before they are saved to finder-program-info.
  16. ;;    Such relative directories can be portable from one Emacs installation
  17. ;;    to another.  Default value is based upon the value of Emacs'
  18. ;;      data-directory variable.
  19.  
  20. ;; This file is part of XEmacs.
  21.  
  22. ;; XEmacs is free software; you can redistribute it and/or modify it
  23. ;; under the terms of the GNU General Public License as published by
  24. ;; the Free Software Foundation; either version 2, or (at your option)
  25. ;; any later version.
  26.  
  27. ;; XEmacs is distributed in the hope that it will be useful, but
  28. ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  29. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  30. ;; General Public License for more details.
  31.  
  32. ;; You should have received a copy of the GNU General Public License
  33. ;; along with XEmacs; see the file COPYING.  If not, write to the Free
  34. ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  35. ;; 02111-1307, USA.
  36.  
  37. ;;; Synched up with: FSF 19.34.
  38.  
  39. ;;; Commentary:
  40.  
  41. ;; This mode uses the Keywords library header to provide code-finding
  42. ;; services by keyword.
  43. ;;
  44. ;; Things to do:
  45. ;;    1. Support multiple keywords per search.  This could be extremely hairy;
  46. ;; there doesn't seem to be any way to get completing-read to exit on
  47. ;; an EOL with no substring pending, which is what we'd want to end the loop.
  48. ;;    2. Search by string in synopsis line?
  49. ;;    3. Function to check finder-package-info for unknown keywords.
  50.  
  51. ;;; Code:
  52.  
  53. (require 'lisp-mnt)
  54. (condition-case nil
  55.     (require 'finder-inf)
  56.   (t nil))
  57. ;; XEmacs addition
  58. (require 'picture)
  59. (require 'mode-motion)
  60.  
  61. (defvar finder-emacs-root-directory
  62.   (file-name-directory (directory-file-name data-directory))
  63.   "Root directory of current emacs tree.")
  64.  
  65. (defvar finder-abbreviate-directory-list
  66.   (list finder-emacs-root-directory)
  67.   "*List of directory roots to remove from finder-package-info directory entries.
  68. The first element in the list is used when expanding relative package
  69. directories to view or extract information from package source code.")
  70.  
  71. (defvar finder-file-regexp "\\.el$"
  72.   "Regexp which matches file names but not Emacs Lisp finder keywords.")
  73.  
  74. ;; Local variable in finder buffer.
  75. (defvar finder-headmark)
  76.  
  77. (defvar finder-known-keywords
  78.   `(
  79.     (abbrev    . "abbreviation handling, typing shortcuts, macros")
  80.     (bib    . "code related to the `bib' bibliography processor")
  81.     (c        . "C, C++, and Objective-C language support")
  82.     (calendar    . "calendar and time management support")
  83.     (comm    . "communications, networking, remote access to files")
  84.     (data    . "support for editing files of data")
  85.     (docs    . "support for Emacs documentation")
  86.     (emulations    . "emulations of other editors")
  87.     (extensions    . "Emacs Lisp language extensions")
  88.     (faces    . "support for multiple fonts")
  89.     (frames    . "support for Emacs frames and window systems")
  90.     (games    . "games, jokes and amusements")
  91.     (hardware    . "support for interfacing with exotic hardware")
  92.     (help    . "support for on-line help systems")
  93.     (hypermedia    . "support for links between text or other media types")
  94.     (i18n    . "internationalization and alternate character-set support")
  95.     (internal    . "code for Emacs internals, build process, defaults")
  96.     (languages    . "specialized modes for editing programming languages")
  97.     (lisp    . "Lisp support, including Emacs Lisp")
  98.     (local    . "code local to your site")
  99.     (maint    . "maintenance aids for the Emacs development group")
  100.     (mail    . "modes for electronic-mail handling")
  101.     (matching    . "various sorts of searching and matching")
  102.     (mouse    . "mouse support")
  103.     ,(when (featurep 'mule)
  104.        (cons 'mule "multi-language extensions"))
  105.     (news    . "support for netnews reading and posting")
  106.     (oop    . "support for object-oriented programming")
  107.     (outlines    . "support for hierarchical outlining")
  108.     (processes    . "process, subshell, compilation, and job control support")
  109.     (terminals    . "support for terminal types")
  110.     (tex    . "code related to the TeX formatter")
  111.     (tools    . "programming tools")
  112.     (unix    . "front-ends/assistants for, or emulators of, UNIX features")
  113.     (vms    . "support code for vms")
  114.     (wp        . "word processing")
  115.     ))
  116.  
  117. (defvar finder-mode-map nil)
  118. (or finder-mode-map
  119.     (let ((map (make-sparse-keymap)))
  120.       (define-key map " "    'finder-select)
  121.       (define-key map "f"    'finder-select)
  122.       (define-key map "\C-m"    'finder-select)
  123.       ;; XEmacs changes
  124.       (define-key map "e"    'finder-edit)
  125.       (define-key map "v"    'finder-view)
  126.       (define-key map "?"    'finder-summary)
  127.       (define-key map "q"    'finder-exit)
  128.       (define-key map "d"    'finder-list-keywords)
  129.       ;; XEmacs change
  130.       (define-key map [button2]    'finder-mouse-select)
  131.       (setq finder-mode-map map)))
  132.  
  133.  
  134. ;;; Code for regenerating the keyword list.
  135.  
  136. (defvar finder-package-info nil
  137.   "Assoc list mapping file names to description & keyword lists.")
  138.  
  139. (defvar finder-compile-keywords-quiet nil
  140.   "If non-nil finder-compile-keywords will not print any messages.")
  141.  
  142. (defun finder-compile-keywords (&rest dirs)
  143.   "Regenerate the keywords association list into the file `finder-inf.el'.
  144. Optional arguments are a list of Emacs Lisp directories to compile from; no
  145. arguments compiles from `load-path'."
  146.   (save-excursion
  147.     ;; XEmacs change
  148.     (find-file "finder-inf.el")
  149.     (let ((processed nil)
  150.       (directory-abbrev-alist
  151.        (append
  152.         (mapcar (function (lambda (dir) (cons dir "")))
  153.             finder-abbreviate-directory-list)
  154.         directory-abbrev-alist))
  155.       (using-load-path))
  156.       (or dirs (setq dirs load-path))
  157.       (setq using-load-path (equal dirs load-path))
  158.       (erase-buffer)
  159.       (insert ";;; finder-inf.el --- keyword-to-package mapping\n")
  160.       (insert ";; Keywords: help\n")
  161.       (insert ";;; Commentary:\n")
  162.       (insert ";; Don't edit this file.  It's generated by finder.el\n\n")
  163.       (insert ";;; Code:\n")
  164.       (insert "\n(setq finder-package-info '(\n")
  165.       (mapcar
  166.        (function
  167.     (lambda (d)
  168.       (mapcar
  169.        (function
  170.         (lambda (f) 
  171.           (if (not (member f processed))
  172.           (let (summary keystart keywords)
  173.             (setq processed (cons f processed))
  174.             (if (not finder-compile-keywords-quiet)
  175.             (message "Processing %s ..." f))
  176.             (save-excursion
  177.               (set-buffer (get-buffer-create "*finder-scratch*"))
  178.               (buffer-disable-undo (current-buffer))
  179.               (erase-buffer)
  180.               (insert-file-contents (expand-file-name f d))
  181.               (setq summary  (lm-synopsis)
  182.                 keywords (lm-keywords)))
  183.             (if (not summary)
  184.             nil
  185.               (insert (format "    (\"%s\"\n        " f))
  186.               (prin1 summary (current-buffer))
  187.               (insert "\n        ")
  188.               (setq keystart (point))
  189.               (insert (if keywords (format "(%s)" keywords) "nil"))
  190.               (subst-char-in-region keystart (point) ?, ? )
  191.               (insert "\n        ")
  192.               (prin1 (abbreviate-file-name d) (current-buffer))
  193.               (insert ")\n"))))))
  194.        ;;
  195.        ;; Skip null, non-existent or relative pathnames, e.g. "./", if
  196.        ;; using load-path, so that they do not interfere with a scan of
  197.        ;; library directories only.
  198.        (if (and using-load-path
  199.             (not (and d (file-name-absolute-p d) (file-exists-p d))))
  200.            nil
  201.          (setq d (file-name-as-directory (or d ".")))
  202.          (directory-files d nil "^[^=].*\\.el$")))))
  203.        dirs)
  204.       (insert "))\n\n(provide 'finder-inf)\n\n;;; finder-inf.el ends here\n")
  205.       (kill-buffer "*finder-scratch*")
  206.       (eval-current-buffer) ;; So we get the new keyword list immediately
  207.       (basic-save-buffer))))
  208.  
  209. (defun finder-compile-keywords-make-dist ()
  210.   "Regenerate `finder-inf.el' for the Emacs distribution."
  211.   (finder-compile-keywords default-directory))
  212.  
  213. ;;; Now the retrieval code
  214.  
  215. (defun finder-insert-at-column (column &rest strings)
  216.   "Insert list of STRINGS, at column COLUMN."
  217.   (if (>= (current-column) column) (insert "\n"))
  218.   (move-to-column column)
  219.   (let ((col (current-column)))
  220.     (if (< col column)
  221.     (indent-to column)
  222.       (if (and (/= col column)
  223.            (= (preceding-char) ?\t))
  224.       (let (indent-tabs-mode)
  225.         (delete-char -1)
  226.             (indent-to col)
  227.             (move-to-column column)))))
  228.   (apply 'insert strings))
  229.  
  230. (defun finder-list-keywords ()
  231.   "Display descriptions of the keywords in the Finder buffer."
  232.   (interactive)
  233.   (setq buffer-read-only nil)
  234.   (erase-buffer)
  235.   (mapcar
  236.    (lambda (assoc)
  237.      (let ((keyword (car assoc)))
  238.        (insert (symbol-name keyword))
  239.        (finder-insert-at-column 14 (concat (cdr assoc) "\n"))
  240.        (cons (symbol-name keyword) keyword)))
  241.    finder-known-keywords)
  242.   (goto-char (point-min))
  243.   (setq finder-headmark (point))
  244.   (setq buffer-read-only t)
  245.   (set-buffer-modified-p nil)
  246.   ;; XEmacs change
  247.   (if (not (one-window-p))
  248.       (balance-windows))
  249.   (finder-summary))
  250.  
  251. (defun finder-list-matches (key)
  252.   (setq buffer-read-only nil)
  253.   (erase-buffer)
  254.   (let ((id (intern key)))
  255.     (insert
  256.      "The following packages match the keyword `" key "':\n\n")
  257.     (setq finder-headmark (point))
  258.     (mapcar
  259.      (lambda (x)
  260.        (if (memq id (car (cdr (cdr x))))
  261.        (progn
  262.          (insert (car x))
  263.          (finder-insert-at-column 16 (concat (car (cdr x)) "\n")))))
  264.      finder-package-info)
  265.     (goto-char (point-min))
  266.     (forward-line)
  267.     (setq buffer-read-only t)
  268.     (set-buffer-modified-p nil)
  269.     (shrink-window-if-larger-than-buffer)
  270.     (finder-summary)))
  271.  
  272. ;; Search for a file named FILE the same way `load' would search.
  273. (defun finder-find-library (file)
  274.   (if (file-name-absolute-p file)
  275.       file
  276.     (let ((dirs load-path)
  277.       found)
  278.       (while (and dirs (not found))
  279.     (if (file-exists-p (expand-file-name (concat file ".el") (car dirs)))
  280.         (setq found (expand-file-name file (car dirs)))
  281.       (if (file-exists-p (expand-file-name file (car dirs)))
  282.           (setq found (expand-file-name file (car dirs)))))
  283.     (setq dirs (cdr dirs)))
  284.       found)))
  285.  
  286. (defun finder-commentary (file)
  287.   (interactive)
  288.   (let* ((str (lm-commentary (finder-find-library file))))
  289.     (if (null str)
  290.     (error "Can't find any Commentary section"))
  291.     (pop-to-buffer "*Finder*")
  292.     ;; XEmacs change
  293.     (setq buffer-read-only nil
  294.       mode-motion-hook 'mode-motion-highlight-line)
  295.     (erase-buffer)
  296.     (insert str)
  297.     (goto-char (point-min))
  298.     (delete-blank-lines)
  299.     (goto-char (point-max))
  300.     (delete-blank-lines)
  301.     (goto-char (point-min))
  302.     (while (re-search-forward "^;+ ?" nil t)
  303.       (replace-match "" nil nil))
  304.     (goto-char (point-min))
  305.     (setq buffer-read-only t)
  306.     (set-buffer-modified-p nil)
  307.     (shrink-window-if-larger-than-buffer)
  308.     (finder-summary)))
  309.  
  310. (defun finder-current-item ()
  311.   (if (and finder-headmark (< (point) finder-headmark))
  312.       (error "No keyword or filename on this line")
  313.     (save-excursion
  314.       (beginning-of-line)
  315.       (current-word))))
  316.  
  317. ;; XEmacs change
  318. (defun finder-edit ()
  319.   (interactive)
  320.   (let ((entry (finder-current-item)))
  321.     (if (string-match finder-file-regexp entry)
  322.     (let ((path (finder-find-library entry)))
  323.       (if path
  324.           (find-file-other-window path)
  325.         (error "Can't find Emacs Lisp library: '%s'" entry)))
  326.       ;; a finder keyword
  327.       (error "Finder-edit works on Emacs Lisp libraries only"))))
  328.  
  329. ;; XEmacs change
  330. (defun finder-view ()
  331.   (interactive)
  332.   (let ((entry (finder-current-item)))
  333.     (if (string-match finder-file-regexp entry)
  334.     (let ((path (finder-find-library entry)))
  335.       (if path
  336.           (view-file-other-window path)
  337.         (error "Can't find Emacs Lisp library: '%s'" entry)))
  338.       ;; a finder keyword
  339.       (error "Finder-view works on Emacs Lisp libraries only"))))
  340.  
  341. (defun finder-select ()
  342.   (interactive)
  343.   (let ((key (finder-current-item)))
  344.     ;; XEmacs change
  345.     (if (string-match finder-file-regexp key)
  346.     (finder-commentary key)
  347.       (finder-list-matches key))))
  348.  
  349. ;; XEmacs change
  350. (defun finder-mouse-select (ev)
  351.   (interactive "e")
  352.   (goto-char (event-point ev))
  353.   (finder-select))
  354.  
  355. (defun finder-by-keyword ()
  356.   "Find packages matching a given keyword."
  357.   (interactive)
  358.   (finder-mode)
  359.   (finder-list-keywords))
  360.  
  361. (defun finder-mode ()
  362.   "Major mode for browsing package documentation.
  363. \\<finder-mode-map>
  364. \\[finder-select]    more help for the item on the current line
  365. \\[finder-edit] edit Lisp library in another window
  366. \\[finder-view] view Lisp library in another window
  367. \\[finder-exit]    exit Finder mode and kill the Finder buffer.
  368. "
  369.   (interactive)
  370.   (pop-to-buffer "*Finder*")
  371.   ;; XEmacs change
  372.   (setq buffer-read-only nil
  373.     mode-motion-hook 'mode-motion-highlight-line)
  374.   (erase-buffer)
  375.   (use-local-map finder-mode-map)
  376.   (set-syntax-table emacs-lisp-mode-syntax-table)
  377.   (setq mode-name "Finder")
  378.   (setq major-mode 'finder-mode)
  379.   (make-local-variable 'finder-headmark)
  380.   (setq finder-headmark nil))
  381.  
  382. (defun finder-summary ()
  383.   "Summarize basic Finder commands."
  384.   (interactive)
  385.   (message "%s"
  386.    (substitute-command-keys
  387.     ;; XEmacs change
  388.     "\\<finder-mode-map>\\[finder-select] = select, \\[finder-list-keywords] = keywords, \\[finder-edit] = edit, \\[finder-view] = view, \\[finder-exit] = quit, \\[finder-summary] = help")))
  389.  
  390. (defun finder-exit ()
  391.   "Exit Finder mode and kill the buffer"
  392.   (interactive)
  393.   ;; XEmacs change
  394.   (or (one-window-p t 0)
  395.       (delete-window))
  396.   (kill-buffer "*Finder*"))
  397.  
  398. (provide 'finder)
  399.  
  400. ;;; finder.el ends here
  401.